/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsr.storage;



import java.util.Calendar;

import org.apache.xmlbeans.GDuration;

import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;

/** This interface encapsulates information pertaining to a group.    
    @author sima patel
    $Date: 2005/03/18 20:18:39 $
    $Revision: 1.3 $
*/
public interface WsrGroupInfo {
  
    /** Retrieve the GroupId */
    public String getGroupId();
  
    /** Check to see if group expiration has been specified */
    public boolean hasGroupExpiryTime();

    /** Retrieve the specified group expiration */
    public Calendar getGroupExpiryTime();

    /** Check to see if an inactivity timeout has been specified */
    public boolean hasGroupMaxIdleDuration();

    /** Retrieve specified inactivity timeout info */
    public GDuration getGroupMaxIdleDuration();
  
    /** Checks to see if there is last sequence number in a given 
    group. It should be noted that the indication of last message is
    available <i>only</i> within the last message in a group. */
    public boolean hasLastSequenceNumber();
   
    /** If we do have information regarding the last message of a Group,
    proceed to retrieve it */
    public long getLastSequenceNumber();
    
    /** If we do have information regarding the sequence Number last 
    Delivered of a Group, proceed to retrieve it */
    public long getSequenceNumberLastDelivered();
  
    /** Checks if this node is the source of the Group in question*/
    public boolean isSource();
  
    /** Checks if this node is the destination of the group in question */
    public boolean isDestination();

   
    /** As the groupId is always generated by source,Returns the source of 
    this group */
    public EndpointReferenceType getSource();
  
    /** Returns the destination of this group */
    public EndpointReferenceType getDestination();
  
    /** Get a byte representation of the Source and Destination address */
    public byte[] getBytesOfAddresses(); 
}